Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Require documentation of public API elements #80

Merged
merged 5 commits into from
Nov 11, 2024

Conversation

ncoghlan
Copy link
Collaborator

@ncoghlan ncoghlan commented Nov 8, 2024

  • Enable docstring linting for public API elements
  • Linting enforces the use of Google-style docstrings
  • Update the names and visibility of various API elements
  • Add missing docstrings to public API elements
  • Fix some docstring text formatting issues
  • Add release notes for these changes and docs process changes

Continues progress on issue #33 (improving the API docs).

* Enable docstring linting for public API elements
* Linting enforces the use of Google-style docstrings
* Update the names and visibility of various API elements
* Add missing docstrings to public API elements
* Fix some docstring text formatting issues
* Add release notes for these changes and docs process changes

Continues progress on issue #33 (improving the API docs).
Copy link

github-actions bot commented Nov 8, 2024

PR Preview Action v1.4.8
Preview removed because the pull request was closed.
2024-11-11 00:35 UTC

@ncoghlan ncoghlan marked this pull request as draft November 8, 2024 12:28
@ncoghlan ncoghlan marked this pull request as ready for review November 8, 2024 12:28
github-actions bot added a commit that referenced this pull request Nov 8, 2024
Update expected test output files from automated/expected-output/20241108-122849-0ccb26c (source PR: #80)
Update expected test output files from automated/expected-output/20241108-122849-0ccb26c (source PR: #80)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@ncoghlan ncoghlan merged commit 1dc66f8 into main Nov 11, 2024
11 checks passed
@ncoghlan ncoghlan deleted the enable-docstring-style-checks branch November 11, 2024 00:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant